Skip to main content

Login and Credentials Using cURL

This page will help you log in and save your credentials for your new integration, with examples of how to use cURL.

Introduction

What is the cURL Command? It is a command available on most Unix-based systems. It is used as an abbreviation for “Client URL”. cURL commands are intended to function as a way to check the connectivity of a URL, as well as being a great data transfer tool.

1. Login

You can run the command below to log in and get your access token.

curl -X 'POST' 'https://grouplink-api.apidatasafe.com/login' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{ "email": "youremail@email.com", "password": "YourPassword", "passcode": "001231", "ttl": 86400 }'

The return of this call will be something similar to {"access_token":"YOUR-ACCESS-TOKEN"}

Copy the returned token to use in the next call to save the credentials

Docs at: GroupLinkAPI Login

2. Save credentials

You can run the command below to save your credentials and get your access-token.

curl -X 'PATCH' 'https://grouplink-api.apidatasafe.com/organization-vault' -H 'Content-Type: application/json' -H 'Authorization: Bearer YOUR-ACCESS-TOKEN' -d '{ "type": "azure_identity", "data": { "tenant_id": "TENANT-123", "client_id": "12345", "client_secret": "G4UL3S", "connection_string": "myconnectionstring" }, "namespace": "batch" }'

The return will be the ID of the created credential

The namespace used must be informed when activating the integration.

It will not be possible to view the complete data after it has been imported. Data is encrypted using AES 256 GCM at the application/database layer and again all data is saved with LUKS at rest on the database server.

Note: type and data change depending on the storage chosen (S3, Azure, Google or direct-link), please check the documentation at GroupLinkAPI OrganizationVault

Example of creating a bucket and access key on AWS: Bucket on AWS to receive files

3. List credentials

You can run the command below to list your credentials and get your access-token.

curl -X 'GET' 'https://grouplink-api.apidatasafe.com/organization-vault' -H 'Authorization: Bearer YOUR-ACCESS-TOKEN'

The return will be a list of credentials with their IDs and information, take the opportunity to check what you registered.

Docs at: GroupLinkAPI OrganizationVaultList

4. If you want to delete a credential

Run the command below replacing 'ID' with the credential ID if you want to delete it

curl -X 'DELETE' 'https://grouplink-api.apidatasafe.com/organization-vault/ID' --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'

The return should be an HTTP 204

Docs at: GroupLinkAPI OrganizationVaultDelete